home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 002 / index.arc / INDEX.DOC < prev   
Encoding:
Text File  |  1985-06-13  |  6.5 KB  |  213 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.                                      INDEX
  30.                              File Indexing Utility
  31.                                       by
  32.                                   Greg Haley
  33.  
  34.                                                                               1
  35.                                  INTRODUCTION
  36.  
  37.   INDEX automatically creates an index for any text file using a list of
  38. words that you provide. The index for this document was created using INDEX.
  39. Here's how it works:
  40.   1) You edit the file to be indexed, inserting form feed characters in the
  41.      file where ever you want a new page. 
  42.  
  43.   2) You create and edit a new file consisting of a list of words you wish
  44.      indexed.
  45.  
  46.   3) You   3) You invoke NDEX, and it searches the file from step 1 for all the words
  47.      in the file from step 2.
  48.  
  49.   4) INDEX produces a 3rd file containing the index. 
  50.  
  51.   5) The index may now be merged with the file from step 1 to make a complete
  52.      document.
  53.  
  54.                                                                               2
  55.                                 GETTING STARTED
  56.  
  57.   To run INDEX, you will need at least 128k of RAM and any computer capable 
  58. of running MS-DOS version 2.xx. You will also need a word processor or text
  59. editor to create the word list file and do minor touch-ups on the index file.
  60.  
  61.                                                                               3
  62.                              PREPARING A TEXT FILE
  63.  
  64.   INDEX looks for form feed characters in the input file to indicate the end of
  65. a page. It is convenient to use the form feed character because this character
  66. also causes the printer to skip to the next page. Therefore, The MS-DOS command
  67. PRINT may be used to print the entire document, form feeds and all.
  68.   
  69.   Entering the form feed characters into the text is a simple matter. Most
  70. text editors and word processors will let you enter control characters
  71. directly into the text. If you're using one of these editors, position the
  72. cursor where you want the end of the page, and press CONTROL L. (Note that
  73. you must hold CONTROL down while pressing L.) If your editor won't let you
  74. enter CONTROL L's, try holding down the ALT key while typing the three 
  75. digits 0, 1, and 2. This procedure lets you enter control characters by 
  76. typing in it's ASCII value; in this case, 12.
  77.  
  78.   When you've finished entering the form feeds, save the file and create
  79. a word list file.
  80.  
  81.                                                                               4
  82.                            CREATING A WORD LIST FILE
  83.  
  84.   The word list file is nothing more than a list of words you want indexed.
  85. The words may be in either upper or lower case and may be in any format. 
  86. However, it is easier to keep up with the words if you limit them to one
  87. word per line. Also, it should be noted that the words may be in any order,
  88. INDEX will sort them automatically. 
  89.   
  90.   After you've created the word list file and inserted form feed characters
  91. in the original text, you're ready to make an index file.
  92.  
  93.                                                                               5
  94.                                 INVOKING INDEX
  95.  
  96.   To run INDEX, type:
  97.  
  98.   INDEX input_pathname output_pathname word_list_pathname
  99.  
  100. where:
  101.  
  102.   input_pathname is the pathname of the file to be indexed.
  103.   output_pathname is the pathname where the index file will be created.
  104.   word_list_pathname is the pathname of the word list file.
  105.  
  106. INDEX will first open all three files, and then read the entire contents
  107. of the word list file. INDEX then displays the number of words it found,
  108. scans the input file, and writes the index to the output file.
  109.  
  110.                                                                               6
  111.                           TOUCHING UP THE INDEX FILE
  112.  
  113.   Since INDEX converts text from both the input file and the word list file
  114. to lower case, words from the word list file will match both upper and lower
  115. case characters in the input file. Thus, the resulting index file is all in
  116. lower case. You may wish to use your editor to make minor changes to the 
  117. index file. Also, the index file may be longer than a printed page, so you may
  118. wish to insert form feed characters into it. 
  119. After you make whatever changes you wish to the index file, you're ready to
  120. merge the index file with your original text file.
  121.  
  122.                                                                               7
  123.                                MERGING THE FILES
  124.  
  125.   After the index file is created, you will probably want to merge the index
  126. file with your original text. This may be done using the MS-DOS COPY command.
  127. If the original text is named DOCUMENT.TXT and the index file is named 
  128. DOCUMENT.IND, and you want the merged file to be named DOCUMENT.DOC, you 
  129. would type:
  130.  
  131.   COPY DOCUMENT.TXT+DOCUMENT.IND DOCUMENT.DOC
  132.  
  133.   The resulting file DOCUMENT.DOC contains the original text plus the index.
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181. * MS-DOS is a trademark of Microsoft, Inc.
  182.  
  183.                                                                               8
  184.                                      INDEX
  185.  
  186.  
  187.     alt keys ............................................................  3
  188.  
  189.     case, upper and lower ...........................................  4,  6
  190.     control L ...........................................................  3
  191.  
  192.     editor ......................................................  2,  3,  6
  193.  
  194.     form feed ...............................................  1,  3,  4,  6
  195.  
  196.     index .......................................  1,  2,  3,  4,  5,  6,  7
  197.     input file ..................................................  3,  5,  6
  198.  
  199.     merge ...........................................................  6,  7
  200.     MS-DOS ......................................................  2,  3,  7
  201.  
  202.     output file .........................................................  5
  203.  
  204.     pathnames ...........................................................  5
  205.     print ...............................................................  3
  206.  
  207.     RAM .................................................................  2
  208.  
  209.     sort ................................................................  4
  210.  
  211.     touching up the index file ..........................................  6
  212.  
  213.     word list file ......................................  2,  3,  4,  5,  6 ..........................................